﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class TextFormatterConfig
 </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class TextFormatterConfig
 ">
  
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
  
  
  
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig">


  <h1 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig" class="text-break">Class TextFormatterConfig
</h1>
  <div class="markdown level0 summary"><p>This class is used as the argument of the <code>CreateFormatter</code>
method of the <code>SECSFormatterFactory</code> which creates a
<code>SECSFormatter</code> object that is implemented to produce logging output
as either SML or XML formatted text.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">TextFormatterConfig</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.html">com.CIMthetics.CSharpSECSTools.TextFormatter</a></h6>
  <h6><strong>Assembly</strong>: TextFormatter.dll</h6>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class TextFormatterConfig</code></pre>
  </div>
  <h3 id="properties">Properties
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_AddDirection_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.AddDirection*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_AddDirection" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.AddDirection">AddDirection</h4>
  <div class="markdown level1 summary"><p>Indicates whether or not message direction information should be
added to the output.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool AddDirection { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p>If <code>true</code> message direction information will be included in
the generated output.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_AddDirection_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The default value is <code>true</code>.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_AddTimestamp_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.AddTimestamp*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_AddTimestamp" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.AddTimestamp">AddTimestamp</h4>
  <div class="markdown level1 summary"><p>Indicates whether or not a timestamp should be added to the
generated output.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool AddTimestamp { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p>If <code>true</code> a timestamp will be included in the
generated output.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_AddTimestamp_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The default value is <code>true</code>.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_BodyOutputConfig_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.BodyOutputConfig*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_BodyOutputConfig" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.BodyOutputConfig">BodyOutputConfig</h4>
  <div class="markdown level1 summary"><p>This property returns the current output configuration
(for <code>SECSItem</code>s) that this formatter is currently
working with.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public BodyOutputConfig BodyOutputConfig { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.BodyOutputConfig.html">BodyOutputConfig</a></td>
        <td><p>If the <code>LoggingOutputFormat</code> property value is &quot;SML&quot;
then the value returned is the value of the <code>SMLOutputConfig.BodyOutputConfig</code>
property.  Otherwise the value returned is the value of the
<code>XMLOutputConfig.BodyOutputConfig</code> property.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_HeaderOutputConfig_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.HeaderOutputConfig*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_HeaderOutputConfig" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.HeaderOutputConfig">HeaderOutputConfig</h4>
  <div class="markdown level1 summary"><p>This property returns the current output configuration
(for <code>SECSHeader</code>s) that this formatter is currently
working with.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public HeaderOutputConfig HeaderOutputConfig { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.HeaderOutputConfig.html">HeaderOutputConfig</a></td>
        <td><p>If the <code>LoggingOutputFormat</code> property value is &quot;SML&quot;
then the value returned is the value of the <code>SMLOutputConfig.HeaderOutputConfig</code>
property.  Otherwise the value returned is the value of the
<code>XMLOutputConfig.HeaderOutputConfig</code> property.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_IndentAmount_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.IndentAmount*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_IndentAmount" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.IndentAmount">IndentAmount</h4>
  <div class="markdown level1 summary"><p>The number of spaces to be used when indentation is required in the
generated output.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int IndentAmount { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><p>The number of spaces to be used when indentation is required in the
generated output.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_IndentAmount_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The default value is 2.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_LoggingOutputFormat_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.LoggingOutputFormat*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_LoggingOutputFormat" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.LoggingOutputFormat">LoggingOutputFormat</h4>
  <div class="markdown level1 summary"><p>This property specifies the kind of output that a
formatter it to produce.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string LoggingOutputFormat { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_LoggingOutputFormat_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The acceptable values are &quot;SML&quot; or &quot;XML&quot;</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_MaxIndentionSpaces_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.MaxIndentionSpaces*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_MaxIndentionSpaces" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.MaxIndentionSpaces">MaxIndentionSpaces</h4>
  <div class="markdown level1 summary"><p>This sets the maximum number of spaces available to be used to provide
indentation for output text generation.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public int MaxIndentionSpaces { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><p>The maximum number of spaces available for indentation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_MaxIndentionSpaces_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This may sound stupid, but, how can you run out of spaces?
Working with <code>string</code>s tends to
produce a lot of garbage that the garbage collector will need to
deal with.  Since many of the programs that use this API may be
executing for a long time and generating a lot of output
the spaces required for indentation
have been preallocated in a <code>string[]</code>.</p>
<p>
Unlike most other properties this property is only used during
the construction of a formatter.  Once created this property
is not used again. Thus, changing its value will not have
any effect.
</p>
<p>
The default value is 48.  Specifying an overly large value for
this property does nothing but use more memory.  If the value
is too small a <span class="xref">System.IndexOutOfRangeException</span>
will be thrown at the point the <code>CurrentIndentLevel</code> exceeds
the value of this property.  See
<a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.SECSFormatter.html#com_CIMthetics_CSharpSECSTools_TextFormatter_SECSFormatter_CurrentIndentLevel">SECSFormatter</a>
for more information.
</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_SMLOutputConfig_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.SMLOutputConfig*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_SMLOutputConfig" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.SMLOutputConfig">SMLOutputConfig</h4>
  <div class="markdown level1 summary"><p>This property specifies the output format information for
a formatter when it is producing output in the SML format.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SMLOutputConfig SMLOutputConfig { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.SMLOutputConfig.html">SMLOutputConfig</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_TimestampFormat_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.TimestampFormat*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_TimestampFormat" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.TimestampFormat">TimestampFormat</h4>
  <div class="markdown level1 summary"><p>If the <code>AddTimestamp</code> property is set to <code>true</code> this is the output
formatting string that is applied to the timestamp as it is
converted to textual form.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string TimestampFormat { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><p>A format string to be applied to the timestamp.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_TimestampFormat_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The default value is &quot;yyyy-MM-ddTHH:mm:ss.fff&quot;.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_XMLOutputConfig_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.XMLOutputConfig*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_XMLOutputConfig" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.XMLOutputConfig">XMLOutputConfig</h4>
  <div class="markdown level1 summary"><p>This property specifies the output format information for
a formatter when it is producing output in the XML format.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public XMLOutputConfig XMLOutputConfig { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.TextFormatter.XMLOutputConfig.html">XMLOutputConfig</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_ToString_" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.ToString*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_TextFormatter_TextFormatterConfig_ToString" data-uid="com.CIMthetics.CSharpSECSTools.TextFormatter.TextFormatterConfig.ToString">ToString()</h4>
  <div class="markdown level1 summary"><p>Creates a <code>string</code> displaying the current &quot;state&quot; of this instance.
This is mostly only useful for debugging.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><span class="xref">System.Object.ToString()</span></div>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
